home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d12 / c_edit.arc / READ.ME < prev    next >
Text File  |  1991-09-08  |  7KB  |  136 lines
  1.            EXPLANATION FOR IBM PC VERSION OF C EDITOR
  2.     
  3.     This  is a significantly enhanced version of the C editor 
  4. published in Dr. Dobb's Journal (Jan. 1982, No. 63 and May, 1983, 
  5. No.  79),  originally written by Edward K.  Ream and modified  by 
  6. and  adapted  for the IBM PC and compatable computers by Alan  D. 
  7. Howard.   This is primarily a program editor as opposed to a word 
  8. processor.  The program consists of several modules:
  9.  
  10.      ED0.C  ED1.CCC  (INCLUDE FILES)
  11.  
  12.      ED2.C  ED3.C ED4.C ED5.C ED6.C ED7.C ED8.C ED9.C ED10.C 
  13.           (SOURCE FILES)
  14.  
  15.      ED11.A  (ASSEMBLER SOURCE FILE FOR SCREEN INPUT AND OUTPUT)
  16.  
  17.      ED.DOC  (DOCUMENTATION OF COMMANDS)     
  18.  
  19.      The source files are not heavily documented except for 
  20. modifications  to the original editor.   The user should  consult 
  21. the  original  Dr.  Dobb's issues for background  information  if 
  22. modification  of  the  editor is to  be  undertaken.   The  major 
  23. enhancements  to the editor since the two articles were published 
  24. include the following:
  25.  
  26.      1.  A macro buffer is now implemented for repetitive editing 
  27. tasks.   Its  use is initiated by pressing the minus key  at  the 
  28. right  end  of the keyboard.   All keystrokes (commands)  entered 
  29. will  be recorded in the buffer (as well as being directly  acted 
  30. upon)  until the minus key is again  pressed.   The  command-mode 
  31. command  COUNT  sets  the  number of times the  macro  is  to  be 
  32. repeated  (default is once).   The right-hand plus key is pressed 
  33. to  cause replay of the macro.   Replay is terminated by  any  of 
  34. several  events,  including:   any keystroke being entered during 
  35. replay;  reaching  the  end or beginning  of  the  buffer,  error 
  36. conditions,   or   attempts  to  replay  file-oriented  commands.  
  37. Conditions  causing  termination  can be modified  by  adding  or 
  38. deleting the function call sysabort() at appropriate locations.
  39.  
  40.      2.  Editing now is more felicitous when tabs are involved in 
  41. the  source line.   The left and right arrows space  one  literal 
  42. character  (tabs  at cursor position cause movement to  next  tab 
  43. stop),  whereas the Alt- and Alt+ keystrokes cause virtual cursor 
  44. movement (by column).   Editing when at a virtual column position 
  45. now  produces less unexpected results.   This portion of the code 
  46. in edins() and edchng() is new and may still contain hidden bugs.
  47.  
  48.      3.  Prompts for commands are indicated by a blinking ">".
  49.  
  50.      4.   Scrolling can either be continuous (Pg Up and Pg Dn) or 
  51. in 20-line units (Ctl Pg Up and Ctl Pg Dn).
  52.  
  53.      5.   A  copy buffer is now provided to permit easy  and,  if 
  54. desired,  repetitive  copying of text lines to elsewhere  in  the 
  55. file.   The  beginning line for copy is marked (invisibly) by F7, 
  56. the end line by F8,  and the block is moved to the copy buffer by 
  57. F9.   The copy buffer is copied to before the current cursor line 
  58. by F10.   The F7 and F8 keys and the current cursor line can also 
  59. be used with commands like DELETE and COPY to mark beginning  and 
  60. ending lines for the commands.   The copy buffer is also used  by 
  61. the  DELETE  command to store the deleted lines (if they fit)  to 
  62. allow  recovery in case of unexpected  results.  The  single-line 
  63. delete command (Del key) does not store the deleted line.
  64.  
  65.      6.   Insert  and  Edit modes are now nearly  symmetrical  in 
  66. their   operation  (many  editing  commands  formerly  were   not 
  67. available during Insert Mode).
  68.  
  69.      Edward Ream has subsequently modified his original editor by 
  70. making the main buffer virtual (like Wordstar, for example).  See 
  71. Dr.  Dobbs, #81 & #82.    The virtual buffer was purposefully not 
  72. added to this version because of its main use as a program editor 
  73. and  to retain the complete user control over the file  read  and 
  74. write names and actions.   
  75.  
  76.      The  editor  has been assembled using  the  C-Ware  (DeSmet) 
  77. compiler.   Use  with other compilers may require modification or 
  78. substitution  for  library routine  calls.   In  particular,  the 
  79. function _move(length,  source offset,  destination offset) moves 
  80. length  bytes  from source to destination;  _memory()  returns  a 
  81. pointer  to the first available memory in the data  segment  (the 
  82. start of the main buffer);  and _os(routine,  argument) calls the 
  83. operating  system.   The screen interface module,  ED11.A,  is  a 
  84. modified  version of the routines PCIO.A supplied with the Desmet 
  85. (C  ware)  C  compiler.   The  inclusion of  this  module  is  by 
  86. permission of C ware and Mark Desmet. 
  87.  
  88.      Have  fun  adding  your own special  features  or  modifying 
  89. existing  features.   Even if you currently have a more  powerful 
  90. editor,  the  editing and buffer routines may be useful for other 
  91. applications, such as support for a digitizer.
  92.  
  93.      This  program is provided to the public domain as a  service 
  94. to programmers.  It may be freely copied and distributed with the 
  95. following restrictions:
  96.  
  97.      1.   Charges  for reproduced copies should be  limited  to 
  98. cost (disks, postage and handling).
  99.  
  100.      2.   Any   modifications to the program from the  originally 
  101. distributed  version  should be clearly indicated,  both  in  the 
  102. source code and the documentation.  Any such modifications should 
  103. retain  the  genealogy of the program,  both in the source  code, 
  104. sign-on message, and documentation.
  105.  
  106.      3.  No commercial resale of the editor, in whole or in part, 
  107. in  source code or in compiled versions of the  source  code,  is 
  108. permitted   without  the  written  permission  of  the   authors, 
  109. including E.K. Ream, Alan D. Howard, and Mark Desmet.
  110.  
  111.      4.   All  documentation and notices supplied with the editor 
  112. should be included in reproduced versions.
  113.  
  114.      5.    In  view of the fact that this editor  is  distributed 
  115. entirely  without  charge,  all warranties  are  disclaimed.   In 
  116. particular, the authors assume no responsibility that the program 
  117. will  operate  as  documented.   The program  authors  cannot  be 
  118. responsible  in any way for direct,  indirect,  or  consequential 
  119. damages.   Any and all risk associated with using the program, in 
  120. whole or in part, is the user's. 
  121.  
  122.                          PROGRAM AUTHORS
  123.  
  124.      Edward K. Ream
  125.      1850 Summit Ave.
  126.      Madison, WI 53705
  127.  
  128.      Alan D. Howard
  129.      Rt. 3, Box 680
  130.      Crozet, VA 22932
  131.  
  132.      Mark Desmet
  133.      C Ware Corporation
  134.      P.O. Box 710097
  135.      San Jose, CA 95171-0097
  136.